deno doc - deno-ja

deno doc

Denoサブコマンド

ソースコード中の定義内容やコメントを元にテキスト形式でドキュメントを表示してくれます

v0.38.0で実装されました

使い方

code:sh

# ビルトインAPIのドキュメントを表示

$ deno doc

$ deno doc --builtin Deno.Listener

# std/http/server.tsのドキュメントを表示

$ deno doc https://deno.land/std@0.106.0/http/server.ts

$ deno doc https://deno.land/std@0.82.0/http/server.ts Server

# JSON形式で表示

$ deno doc std/encoding/csv.ts --json

というサイトではWeb上のtsファイルのドキュメントをサイトとしてサーブしてくれる

doc.deno.landに移動したようですuki00a.icon

例: https://deno-doc.now.sh/https/servestjs.org/@/router.ts

パスにURLっぽいのを入れると良いようです

TypeScriptから使うこともできます

code:sample.ts

import { doc } from "https://deno.land/x/deno_doc@v0.12.1/mod.ts";

console.log(await doc("https://deno.land/std@0.106.0/http/server.ts"));